-
Notifications
You must be signed in to change notification settings - Fork 5.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add versioning to argocd docs #5099
Conversation
517bd1d
to
b14353f
Compare
b14353f
to
44d3dca
Compare
Thank you for implementing the version selector and banner! The only concern I have is the maturity of mike and maintenance overhead. I want to propose to use https://readthedocs.org/ instead of mike. It automates version management and supports mkdocs . What do you think? @reginapizza |
Changes in argocd-notifications still don't have banner that notifies users about the latest version. We could use code implemented in this PR to add it. https://readthedocs.org/ inject information about current version into If you like the idea to use https://readthedocs.org/ I would suggest implement banner in argocd-notifications and then we can re-use this JS file in argocd and argocd-image-updater. |
44d3dca
to
ef465a6
Compare
Codecov Report
@@ Coverage Diff @@
## master #5099 +/- ##
=======================================
Coverage 40.91% 40.92%
=======================================
Files 137 137
Lines 18594 18597 +3
=======================================
+ Hits 7608 7611 +3
Misses 9899 9899
Partials 1087 1087
Continue to review full report at Codecov.
|
56c04ee
to
d0c5b9e
Compare
Signed-off-by: Regina Scott <rescott@redhat.com>
d0c5b9e
to
67f374c
Compare
Hey @alexmt ! This should be good now, but in order to move it to the argocd project the project name in versions.js will just need to be changed out of my project, unless you want to keep it there since I made you a maintainer of it anyway. Up to you. Here are screenshots of it, but you can also see it in action here. |
Hey, this really awesome @reginapizza! I really like how you integrated the versions in the top bar, instead of having the default black float of RTD. And the banner is awesome, too. I have one minor request for change: Since we want to redirect the user to the current I also wonder if it is possible to find out which version of the docs in RTD corresponds to |
@jannfis Thank you! Regarding your requests,
I can totally do this no problem. There is a setting you change (see below) in RTD project settings and I can easily change the default version to stable. I can also change the link so that it redirects from other versions to stable, and I can add a banner to warn the user when they are on latest branch that information might not yet be released.
I'm not sure about this though... this what RTD gives you to work with, I don't think that I can have an alias for anything besides "latest", but I'm not positive. I can try to look into it, unless @alexmt knows? |
That looks awesome @reginapizza! Thank you! Agree with @jannfis comment. We should assume default version is |
f795b65
to
dcfa6c0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Regina Scott <rescott@redhat.com>
dcfa6c0
to
95f5991
Compare
🎉 Can we cherry-pick this into 1.8 branch, so we can already activate a 1.8 version of the docs in addition to master :) I have re-configured RTD default branch to |
You are reading my minds :) doing it right now |
* feat: add versioning to argocd docs Signed-off-by: Regina Scott <rescott@redhat.com> * make default branch stable, provide warning for latest Signed-off-by: Regina Scott <rescott@redhat.com>
* feat: add versioning to argocd docs Signed-off-by: Regina Scott <rescott@redhat.com> * make default branch stable, provide warning for latest Signed-off-by: Regina Scott <rescott@redhat.com>
This PR is to add versioning to the Argo CD docs. The core functionality of this versioning is done through mike. Related to issue #5031.
Additional functionality:
Screenshots:
output.mp4
Checklist: